#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""
generate_readme.py - 用于自动生成项目README.md文件的脚本
"""

import os

def generate_readme(template):
    # 构建README内容
    readme_content = f"""
# {template['project_name']}

{template['description']}

## 目录
- [项目概述](#项目概述)
- [使用方法](#使用方法)
- [修改记录](#修改记录)

## 项目概述
{template['overview']}

## 使用方法
{template['usage']}

## 修改记录
| 版本 | 日期       | 修改内容          |
|------|------------|-------------------|
"""
    for change in template['changes']:
        readme_content += f"| {change['version']} | {change['date']} | {change['change']} |\n"

    # 写入文件
    with open("README.md", "w", encoding="utf-8") as file:
        file.write(readme_content.strip())

    print("README.md 文件已成功创建！")

if __name__ == "__main__":
    # 定义README模板的数据
    readme_template = {
        "project_name": "My Awesome Script",
        "description": "这是一个用来演示如何自动创建README.md文件的简单Python脚本。",
        "overview": "此脚本提供了一个简单的命令行工具，用于自动化生成Markdown格式的README文件。",
        "usage": """
        ### 如何使用
        1. 确保安装了Python环境。
        2. 将此脚本放置于您的项目目录下。
        3. 运行 `python generate_readme.py` 来生成README文件。
        """,
        "changes": [
            {"version": "0.1", "date": "2024-12-02", "change": "初始版本发布。"},
            # 可以添加更多版本信息
        ]
    }

    # 调用函数
    generate_readme(readme_template)